<!doctype html>
<html>

<head>
  <meta name="generator" content="JSDoc 3.6.11">
  <meta charset="utf-8">
  <title>whatsapp-web.js 1.26.1-alpha.3 &raquo; Class: BusinessContact</title>
  <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Karla:400,400i,700,700i" type="text/css">
  <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Noto+Serif:400,400i,700,700i" type="text/css">
  <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
  <link href="css/baseline.css" rel="stylesheet">
</head>

<body onload="prettyPrint()">
  <nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
    <div id="jsdoc-navbar-container">
      <div id="jsdoc-navbar-content">
        <a href="index.html" class="jsdoc-navbar-package-name">whatsapp-web.<wbr>js 1.<wbr>26.<wbr>1-alpha.<wbr>3</a>
      </div>
    </div>
  </nav>
  <div id="jsdoc-body-container">
    <div id="jsdoc-content">
      <div id="jsdoc-content-container">
        <div id="jsdoc-main" role="main">
          <header class="page-header">
            <div class="symbol-detail-labels"><span class="label label-kind">class</span></div>
            <h1><small></small><span class="symbol-name">BusinessContact</span></h1>
            <p class="source-link">Source: <a href="structures_BusinessContact.js.html#source-line-9">structures/<wbr>BusinessContact.<wbr>js:9</a></p>
            <div class="symbol-classdesc">
              <p>Represents a Business Contact on WhatsApp</p>
            </div>
            <dl class="dl-compact">
            </dl>
          </header>
          <section id="summary">
            <div class="summary-callout">
              <h2 class="summary-callout-heading">Properties</h2>
              <div class="summary-content">
                <div class="summary-column">
                  <dl class="dl-summary-callout">
                    <dt><a href="BusinessContact.html#businessProfile">businessProfile</a></dt>
                    <dd>
                    </dd>
                    <dt><a href="BusinessContact.html#id">id</a></dt>
                    <dd>
                    </dd>
                    <dt><a href="BusinessContact.html#isBlocked">isBlocked</a></dt>
                    <dd>
                    </dd>
                    <dt><a href="BusinessContact.html#isBusiness">isBusiness</a></dt>
                    <dd>
                    </dd>
                    <dt><a href="BusinessContact.html#isEnterprise">isEnterprise</a></dt>
                    <dd>
                    </dd>
                  </dl>
                </div>
                <div class="summary-column">
                  <dl class="dl-summary-callout">
                    <dt><a href="BusinessContact.html#isGroup">isGroup</a></dt>
                    <dd>
                    </dd>
                    <dt><a href="BusinessContact.html#isMe">isMe</a></dt>
                    <dd>
                    </dd>
                    <dt><a href="BusinessContact.html#isMyContact">isMyContact</a></dt>
                    <dd>
                    </dd>
                    <dt><a href="BusinessContact.html#isUser">isUser</a></dt>
                    <dd>
                    </dd>
                    <dt><a href="BusinessContact.html#isWAContact">isWAContact</a></dt>
                    <dd>
                    </dd>
                  </dl>
                </div>
                <div class="summary-column">
                  <dl class="dl-summary-callout">
                    <dt><a href="BusinessContact.html#name">name</a></dt>
                    <dd>
                    </dd>
                    <dt><a href="BusinessContact.html#number">number</a></dt>
                    <dd>
                    </dd>
                    <dt><a href="BusinessContact.html#pushname">pushname</a></dt>
                    <dd>
                    </dd>
                    <dt><a href="BusinessContact.html#shortName">shortName</a></dt>
                    <dd>
                    </dd>
                  </dl>
                </div>
              </div>
            </div>
            <div class="summary-callout">
              <h2 class="summary-callout-heading">Methods</h2>
              <div class="summary-content">
                <div class="summary-column">
                  <dl class="dl-summary-callout">
                    <dt><a href="BusinessContact.html#block">block()</a></dt>
                    <dd>
                    </dd>
                    <dt><a href="BusinessContact.html#getAbout">getAbout()</a></dt>
                    <dd>
                    </dd>
                    <dt><a href="BusinessContact.html#getChat">getChat()</a></dt>
                    <dd>
                    </dd>
                  </dl>
                </div>
                <div class="summary-column">
                  <dl class="dl-summary-callout">
                    <dt><a href="BusinessContact.html#getCommonGroups">getCommonGroups()</a></dt>
                    <dd>
                    </dd>
                    <dt><a href="BusinessContact.html#getCountryCode">getCountryCode()</a></dt>
                    <dd>
                    </dd>
                    <dt><a href="BusinessContact.html#getFormattedNumber">getFormattedNumber()</a></dt>
                    <dd>
                    </dd>
                  </dl>
                </div>
                <div class="summary-column">
                  <dl class="dl-summary-callout">
                    <dt><a href="BusinessContact.html#getProfilePicUrl">getProfilePicUrl()</a></dt>
                    <dd>
                    </dd>
                    <dt><a href="BusinessContact.html#unblock">unblock()</a></dt>
                    <dd>
                    </dd>
                  </dl>
                </div>
              </div>
            </div>
          </section>
          <section>
            <h2 id="BusinessContact">new&nbsp;<span class="symbol-name">BusinessContact</span><span class="signature"><span class="signature-params">()</span></span></h2>
            <dl class="dl-compact">
              <dt>Extends</dt>
              <dd><a href="Contact.html">Contact</a></dd>
            </dl>
          </section>
          <section>
            <h2>Properties</h2>
            <section>
              <h3 id="businessProfile"><span class="symbol-name">businessProfile</span></h3>
              <p>The contact's business profile</p>
              <dl class="dl-compact">
              </dl>
              <h3 id="id"><span class="symbol-name">id</span><small class="property-type">
                  &nbsp;unknown</small></h3>
              <p>ID that represents the contact</p>
              <dl class="dl-compact">
                <dt>Inherited from</dt>
                <dd><a href="Contact.html#id">Contact#id</a></dd>
              </dl>
              <h3 id="isBlocked"><span class="symbol-name">isBlocked</span><small class="property-type">
                  &nbsp;unknown</small></h3>
              <p>Indicates if you have blocked this contact</p>
              <dl class="dl-compact">
                <dt>Inherited from</dt>
                <dd><a href="Contact.html#isBlocked">Contact#isBlocked</a></dd>
              </dl>
              <h3 id="isBusiness"><span class="symbol-name">isBusiness</span><small class="property-type">
                  &nbsp;unknown</small></h3>
              <p>Indicates if the contact is a business contact</p>
              <dl class="dl-compact">
                <dt>Inherited from</dt>
                <dd><a href="Contact.html#isBusiness">Contact#isBusiness</a></dd>
              </dl>
              <h3 id="isEnterprise"><span class="symbol-name">isEnterprise</span><small class="property-type">
                  &nbsp;unknown</small></h3>
              <p>Indicates if the contact is an enterprise contact</p>
              <dl class="dl-compact">
                <dt>Inherited from</dt>
                <dd><a href="Contact.html#isEnterprise">Contact#isEnterprise</a></dd>
              </dl>
              <h3 id="isGroup"><span class="symbol-name">isGroup</span><small class="property-type">
                  &nbsp;unknown</small></h3>
              <p>Indicates if the contact is a group contact</p>
              <dl class="dl-compact">
                <dt>Inherited from</dt>
                <dd><a href="Contact.html#isGroup">Contact#isGroup</a></dd>
              </dl>
              <h3 id="isMe"><span class="symbol-name">isMe</span><small class="property-type">
                  &nbsp;unknown</small></h3>
              <p>Indicates if the contact is the current user's contact</p>
              <dl class="dl-compact">
                <dt>Inherited from</dt>
                <dd><a href="Contact.html#isMe">Contact#isMe</a></dd>
              </dl>
              <h3 id="isMyContact"><span class="symbol-name">isMyContact</span><small class="property-type">
                  &nbsp;unknown</small></h3>
              <p>Indicates if the number is saved in the current phone's contacts</p>
              <dl class="dl-compact">
                <dt>Inherited from</dt>
                <dd><a href="Contact.html#isMyContact">Contact#isMyContact</a></dd>
              </dl>
              <h3 id="isUser"><span class="symbol-name">isUser</span><small class="property-type">
                  &nbsp;unknown</small></h3>
              <p>Indicates if the contact is a user contact</p>
              <dl class="dl-compact">
                <dt>Inherited from</dt>
                <dd><a href="Contact.html#isUser">Contact#isUser</a></dd>
              </dl>
              <h3 id="isWAContact"><span class="symbol-name">isWAContact</span><small class="property-type">
                  &nbsp;unknown</small></h3>
              <p>Indicates if the number is registered on WhatsApp</p>
              <dl class="dl-compact">
                <dt>Inherited from</dt>
                <dd><a href="Contact.html#isWAContact">Contact#isWAContact</a></dd>
              </dl>
              <h3 id="name"><span class="symbol-name">name</span><small class="property-type">
                  &nbsp;unknown</small></h3>
              <p>The contact's name, as saved by the current user</p>
              <dl class="dl-compact">
                <dt>Inherited from</dt>
                <dd><a href="Contact.html#name">Contact#name</a></dd>
              </dl>
              <h3 id="number"><span class="symbol-name">number</span><small class="property-type">
                  &nbsp;unknown</small></h3>
              <p>Contact's phone number</p>
              <dl class="dl-compact">
                <dt>Inherited from</dt>
                <dd><a href="Contact.html#number">Contact#number</a></dd>
              </dl>
              <h3 id="pushname"><span class="symbol-name">pushname</span><small class="property-type">
                  &nbsp;unknown</small></h3>
              <p>The name that the contact has configured to be shown publically</p>
              <dl class="dl-compact">
                <dt>Inherited from</dt>
                <dd><a href="Contact.html#pushname">Contact#pushname</a></dd>
              </dl>
              <h3 id="shortName"><span class="symbol-name">shortName</span><small class="property-type">
                  &nbsp;unknown</small></h3>
              <p>A shortened version of name</p>
              <dl class="dl-compact">
                <dt>Inherited from</dt>
                <dd><a href="Contact.html#shortName">Contact#shortName</a></dd>
              </dl>
            </section>
            <h2>Methods</h2>
            <section>
              <div class="symbol-detail-labels"><span class="label label-async">async</span></div>
              <h3 id="block"><span class="symbol-name">block</span><span class="signature"><span class="signature-params">()</span>&nbsp;&rarr; <span class="signature-returns"> Promise containing boolean</span></span></h3>
              <p>Blocks this contact from WhatsApp</p>
              <dl class="dl-compact">
                <dt>Inherited from</dt>
                <dd><a href="Contact.html#block">Contact#block</a></dd>
                <dt>Returns</dt>
                <dd></dd>
              </dl>
              <div class="symbol-detail-labels"><span class="label label-async">async</span></div>
              <h3 id="getAbout"><span class="symbol-name">getAbout</span><span class="signature"><span class="signature-params">()</span>&nbsp;&rarr; <span class="signature-returns"> Promise containing nullable string</span></span></h3>
              <p>Gets the Contact's current &quot;about&quot; info. Returns null if you don't have permission to read their status.</p>
              <dl class="dl-compact">
                <dt>Inherited from</dt>
                <dd><a href="Contact.html#getAbout">Contact#getAbout</a></dd>
                <dt>Returns</dt>
                <dd></dd>
              </dl>
              <div class="symbol-detail-labels"><span class="label label-async">async</span></div>
              <h3 id="getChat"><span class="symbol-name">getChat</span><span class="signature"><span class="signature-params">()</span>&nbsp;&rarr; <span class="signature-returns"> Promise containing <a href="Chat.html">Chat</a></span></span></h3>
              <p>Returns the Chat that corresponds to this Contact.
                Will return null when getting chat for currently logged in user.</p>
              <dl class="dl-compact">
                <dt>Inherited from</dt>
                <dd><a href="Contact.html#getChat">Contact#getChat</a></dd>
                <dt>Returns</dt>
                <dd></dd>
              </dl>
              <div class="symbol-detail-labels"><span class="label label-async">async</span></div>
              <h3 id="getCommonGroups"><span class="symbol-name">getCommonGroups</span><span class="signature"><span class="signature-params">()</span>&nbsp;&rarr; <span class="signature-returns"> Promise containing Array of WAWebJS.ChatId</span></span></h3>
              <p>Gets the Contact's common groups with you. Returns empty array if you don't have any common group.</p>
              <dl class="dl-compact">
                <dt>Inherited from</dt>
                <dd><a href="Contact.html#getCommonGroups">Contact#getCommonGroups</a></dd>
                <dt>Returns</dt>
                <dd></dd>
              </dl>
              <div class="symbol-detail-labels"><span class="label label-async">async</span></div>
              <h3 id="getCountryCode"><span class="symbol-name">getCountryCode</span><span class="signature"><span class="signature-params">()</span>&nbsp;&rarr; <span class="signature-returns"> Promise containing string</span></span></h3>
              <p>Returns the contact's countrycode, (1541859685@c.us) =&gt; (1)</p>
              <dl class="dl-compact">
                <dt>Inherited from</dt>
                <dd><a href="Contact.html#getCountryCode">Contact#getCountryCode</a></dd>
                <dt>Returns</dt>
                <dd></dd>
              </dl>
              <div class="symbol-detail-labels"><span class="label label-async">async</span></div>
              <h3 id="getFormattedNumber"><span class="symbol-name">getFormattedNumber</span><span class="signature"><span class="signature-params">()</span>&nbsp;&rarr; <span class="signature-returns"> Promise containing string</span></span></h3>
              <p>Returns the contact's formatted phone number, (12345678901@c.us) =&gt; (+1 (234) 5678-901)</p>
              <dl class="dl-compact">
                <dt>Inherited from</dt>
                <dd><a href="Contact.html#getFormattedNumber">Contact#getFormattedNumber</a></dd>
                <dt>Returns</dt>
                <dd></dd>
              </dl>
              <div class="symbol-detail-labels"><span class="label label-async">async</span></div>
              <h3 id="getProfilePicUrl"><span class="symbol-name">getProfilePicUrl</span><span class="signature"><span class="signature-params">()</span>&nbsp;&rarr; <span class="signature-returns"> Promise containing string</span></span></h3>
              <p>Returns the contact's profile picture URL, if privacy settings allow it</p>
              <dl class="dl-compact">
                <dt>Inherited from</dt>
                <dd><a href="Contact.html#getProfilePicUrl">Contact#getProfilePicUrl</a></dd>
                <dt>Returns</dt>
                <dd></dd>
              </dl>
              <div class="symbol-detail-labels"><span class="label label-async">async</span></div>
              <h3 id="unblock"><span class="symbol-name">unblock</span><span class="signature"><span class="signature-params">()</span>&nbsp;&rarr; <span class="signature-returns"> Promise containing boolean</span></span></h3>
              <p>Unblocks this contact from WhatsApp</p>
              <dl class="dl-compact">
                <dt>Inherited from</dt>
                <dd><a href="Contact.html#unblock">Contact#unblock</a></dd>
                <dt>Returns</dt>
                <dd></dd>
              </dl>
            </section>
          </section>
        </div>
      </div>
      <nav id="jsdoc-toc-nav" role="navigation"></nav>
    </div>
  </div>
  <footer id="jsdoc-footer" class="jsdoc-footer">
    <div id="jsdoc-footer-container">
      <p>
        Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> 3.6.11 on November 22, 2024.
      </p>
    </div>
  </footer>
  <script src="scripts/jquery.min.js"></script>
  <script src="scripts/tree.jquery.js"></script>
  <script src="scripts/prettify.js"></script>
  <script src="scripts/jsdoc-toc.js"></script>
  <script src="scripts/linenumber.js"></script>
  <script src="scripts/scrollanchor.js"></script>
</body>

</html>